docs(analyzer): Improve PackageManager class documentation
#9637
Conversation
| * [projectType]. The analysis of any projects and their dependencies starts in the [analysisRoot] directory using the | ||
| * given general [analyzerConfig]. Per-repository configuration is passed in [repoConfig]. | ||
| * A class to represent a package manager with the given [managerName] that handles projects of the given [projectType]. | ||
| * The analysis of any projects and their dependencies starts in the [analysisRoot] directory using the given general |
There was a problem hiding this comment.
You can also consider these out of scope, but it may make sense to address it while at it:
- Removing "general" from "given general" as it seems to not provide any info.
- "Per-repository" configuration is misleading, for mono repos where you can have multiple repository
configurations in the repository. proposa, say:
"The analysis of any projects and their dependencies starts in the [analysisRoot] directory using the given
analyzerConfigandrepoConfig."
edit: If one want to emphasize the difference, maybe saying "the project-agnostic analyzerConfig and the project-specific repoConfig" would be a better fit.
There was a problem hiding this comment.
I believe "general" was there exactly to make the difference between AnalyzerConfiguration and RepositoryConfiguration.RepositoryAnalyzerConfiguration more clear.
I'll try to think of a better wording.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9637 +/- ##
=========================================
Coverage 68.05% 68.05%
Complexity 1285 1285
=========================================
Files 249 249
Lines 8835 8835
Branches 921 921
=========================================
Hits 6013 6013
Misses 2433 2433
Partials 389 389
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Specifically, clarify that the `projectType` does not refer to dependencies. Signed-off-by: Sebastian Schuberth <[email protected]>
sschuberth
force-pushed
the
ref/heads/pm-type-docs
branch
from
1ccb227 to
3a25a2c
Compare
Specifically, clarify that the
projectTypedoes not refer to dependencies.